Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add platform ssh docs #469

Merged
merged 3 commits into from
Oct 18, 2023
Merged

Conversation

beguene
Copy link
Collaborator

@beguene beguene commented Sep 20, 2023

This is a draft version of the documentation for the platform ssh or how to setup a local editor for the Hiro Platform.
Not to be merged yet as the feature is not yet released on the platform.

@netlify
Copy link

netlify bot commented Sep 20, 2023

Deploy Preview for docs-hiro ready!

Name Link
🔨 Latest commit d9e9253
🔍 Latest deploy log https://app.netlify.com/sites/docs-hiro/deploys/650c0f86103e680008788b88
😎 Deploy Preview https://deploy-preview-469--docs-hiro.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@vercel
Copy link

vercel bot commented Sep 20, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
hiro-systems-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 17, 2023 4:03pm

Copy link
Contributor

@sabbyanandan sabbyanandan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is looking great! I left a few suggestions. We could also add the screenshots when they are ready.

sidebars.js Outdated Show resolved Hide resolved
docs/platform/setting-up-local-editor.md Outdated Show resolved Hide resolved
docs/platform/setting-up-local-editor.md Outdated Show resolved Hide resolved
@andresgalante
Copy link
Member

andresgalante commented Sep 25, 2023

@ryanwaits would you be able to review this one, please?

@andresgalante andresgalante requested review from mefrem and ryanwaits and removed request for andresgalante, BLuEScioN and mefrem September 25, 2023 15:28

## Save your SSH Key

Next, you'll provide your public key to the Hiro Platform. You can do this by copying your public key and pasting it into the SSH Public Key field in the Hiro Platform.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

might be nice to add a code snippet for how to copy pk, ex:

for mac: cat ~/.ssh/id_rsa.pub | pbcopy

also, where in the platform would someone find where to paste in the public key? i did a quick check and wasn't sure where to add it.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added for Linux, Mac and Windows and a short phrase and a direct link to the settings (where the user can add the ssh keys)

ForwardAgent yes
```

Replace `<your-workspace-url>` with the actual URL of your pod, which should look something like this: https://4a1b57d0c473.platform.hiro.so/
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe add some context on how to find the unique pod url, ie you must open a specific project in the editor to find it (unless theres somewhere else in the app where you can find)

@beguene
Copy link
Collaborator Author

beguene commented Oct 10, 2023

Thanks @ryanwaits for the comments, I addressed those. Let me know if you find anything else, I will be happy to update it.

@beguene
Copy link
Collaborator Author

beguene commented Oct 12, 2023

@andresgalante @ryanwaits Shall I merge this ?

@beguene beguene force-pushed the feat/add-platform-local-development-ssh branch from 9e53659 to d017ef0 Compare October 17, 2023 13:37
@beguene
Copy link
Collaborator Author

beguene commented Oct 17, 2023

@sabbyanandan I made the changes you requested, but I can't merge it until you approve. Let me know if there are still things missing.

docs/platform/connect-desktop-to-cloud.md Outdated Show resolved Hide resolved
docs/platform/connect-desktop-to-cloud.md Outdated Show resolved Hide resolved
docs/platform/connect-desktop-to-cloud.md Outdated Show resolved Hide resolved
docs/platform/connect-desktop-to-cloud.md Outdated Show resolved Hide resolved
Co-authored-by: Sabby Anandan <sabby@hiro.so>
Copy link
Contributor

@sabbyanandan sabbyanandan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's go!

@beguene beguene merged commit 2a034d6 into main Oct 18, 2023
4 checks passed
@beguene beguene deleted the feat/add-platform-local-development-ssh branch October 18, 2023 05:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants